DigiOffice Gateway Web Services

<back to all web services

GetProjectDetailsTBI

Get project details

Requires Authentication
The following routes are available for this service:
GET/api/tbi/Projects/{ID}
namespace DO.API.TBI.API.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Veld() = 
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val Value:Object = null with get,set
        member val Description:String = null with get,set
        member val GlobalID:Nullable<Guid> = new Nullable<Guid>() with get,set

    [<AllowNullLiteral>]
    type ProjectDetailsTBI() = 
        member val Velden:ResizeArray<Veld> = new ResizeArray<Veld>() with get,set

    ///<summary>
    ///Get project details
    ///</summary>
    [<Api(Description="Get project details")>]
    [<AllowNullLiteral>]
    type GetProjectDetailsTBI() = 
        ///<summary>
        ///ID or GlobalID
        ///</summary>
        [<ApiMember(Description="ID or GlobalID", IsRequired=true)>]
        member val ID:String = null with get,set

F# GetProjectDetailsTBI DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/tbi/Projects/{ID} HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDetailsTBI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.API.TBI.API.DTO">
  <Velden>
    <Veld>
      <Description>String</Description>
      <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
      <Name>String</Name>
      <Type>String</Type>
      <Value />
    </Veld>
  </Velden>
</ProjectDetailsTBI>